Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(dynamite): test documentation of generated libraries #1386

Merged
merged 1 commit into from
Jan 9, 2024
Merged

fix(dynamite): test documentation of generated libraries #1386

merged 1 commit into from
Jan 9, 2024

Conversation

Leptopoda
Copy link
Member

Currently depends on the next release of code_builder.
Once it is done I'll regenerate the specs for every commit and drop the current dependency overrides.

pana output for nextcloud: 7701 out of 20941 API elements (36.8 %) have documentation comments.

@provokateurin
Copy link
Member

Would it be possible to already separate and merge some of the commits?

@Leptopoda
Copy link
Member Author

I think all other than 885b6c1 (and the documentation unit test) would already be possible.
Do you prefer single PRs per commit or one with al changes?

@provokateurin
Copy link
Member

Just group them in a way you think makes sense :)

@Leptopoda Leptopoda linked an issue Dec 29, 2023 that may be closed by this pull request
Generate doc comments for class and methods that can't be documented in the OpenAPI specifications #1380
Closed
@Leptopoda Leptopoda mentioned this pull request Dec 29, 2023
Merged
@Leptopoda
Copy link
Member Author

looks like we'll get a release really soon
dart-archive/code_builder#445

@Leptopoda Leptopoda force-pushed the test/dynamite/document-output branch from 055663a to 69f7d68 Compare December 30, 2023 10:40
@Leptopoda Leptopoda changed the title fix(dynamite): do not split tags at fix(dynamite): test documentation of generated libraries Dec 30, 2023
@Leptopoda Leptopoda force-pushed the test/dynamite/document-output branch from 69f7d68 to a004156 Compare January 8, 2024 21:12
@Leptopoda
Copy link
Member Author

just a rebase for now.
@provokateurin our current dynamite code does not allow easily documenting interfaces or typedefs. Should I just add a local ignore for them?

@provokateurin
Copy link
Member

our current dynamite code does not allow easily documenting interfaces or typedefs. Should I just add a local ignore for them?

Can you explain to me why? I'm fine with an ignore if there is nothing better right now.

@Leptopoda
Copy link
Member Author

  1. only direct interfaces have doc comments. All interfaces generated by AllOfs can't be documented.
  2. adding them to top level typedefs would require adding a docs field to the TypeResult that is only used by the typedefs.
    I don't like having it in there as it would only further clutter the typeresults

@Leptopoda Leptopoda force-pushed the test/dynamite/document-output branch 2 times, most recently from 31f254f to 2d481f6 Compare January 9, 2024 12:36
@Leptopoda Leptopoda marked this pull request as ready for review January 9, 2024 12:36
@provokateurin
Copy link
Member

Now we need to add a latin dictionary 😂

provokateurin
provokateurin requested changes Jan 9, 2024
View reviewed changes
Copy link
Member

@provokateurin provokateurin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The links to the licenses should be quoted to avoid the final dot being part of the link.

packages/dynamite/dynamite/lib/src/builder/generate_schemas.dart Show resolved Hide resolved
@Leptopoda Leptopoda force-pushed the test/dynamite/document-output branch from 2d481f6 to 671e1b1 Compare January 9, 2024 15:34
@Leptopoda Leptopoda enabled auto-merge January 9, 2024 15:50
@Leptopoda Leptopoda merged commit 35585aa into main Jan 9, 2024
8 checks passed
@Leptopoda Leptopoda deleted the test/dynamite/document-output branch January 9, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@provokateurin provokateurin provokateurin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Generate doc comments for class and methods that can't be documented in the OpenAPI specifications
2 participants
@Leptopoda @provokateurin